home *** CD-ROM | disk | FTP | other *** search
/ Aminet 8 / Aminet 8 (1995)(GTI - Schatztruhe)[!][Oct 1995].iso / Aminet / dev / gui / TextLabelImage.lha / TextLabel / doc / textlabel_ic.doc next >
Text File  |  1995-06-26  |  4KB  |  117 lines
  1. TABLE OF CONTENTS
  2.  
  3. textlabel.image/--datasheet--
  4. textlabel.image/IM_DRAWFRAME
  5. textlabel.image/--datasheet--                   textlabel.image/--datasheet--
  6.  
  7.    NAME
  8.       textlabel.image -- text labels with underscore support
  9.  
  10.    SUPERCLASS
  11.       imageclass
  12.  
  13.    DESCRIPTION
  14.       The textlabel.image class is used to create gadget labels.
  15.       These are single-lined texts with the gadget shortcut marked
  16.       by underlining the appropriate letter.
  17.  
  18.    METHODS
  19.       OM_NEW  -- Create the text label.  Passed to superclass, then OM_SET.
  20.  
  21.       OM_SET  -- Set object attributes.  Passed to superclass first.
  22.  
  23.       OM_GET  -- Get obejct attributes.  Passed to superclass first.
  24.  
  25.       OM_UPDATE -- Set object notification attributes.  Passed to
  26.                    superclass first.
  27.  
  28.       IM_DRAW -- Draw the text label. Overrides the superclass.
  29.  
  30.       IM_DRAWFRAME -- Draw text label within a frame.  Overrides the
  31.                       superclass.
  32.  
  33.       All other methods are passed to the superclass, including
  34.       OM_DISPOSE.
  35.  
  36.    ATTRIBUTES
  37.       For some attributes there are aliases defined.
  38.  
  39.       IA_DATA, TLA_TEXT ( *CHAR, IS )
  40.           Label text.
  41.  
  42.       TLA_UNDERSCORE ( CHAR, IS )
  43.           Charakter to be used to determine the underscore position
  44.           within the string.  The charakter following the first
  45.           occurance of this one will become the shortcut.
  46.           Default: "_" (underscore).
  47.  
  48.       TLA_KEY ( CHAR, G )
  49.           The shortcut key of this label.
  50.  
  51.       IA_FONT, TLA_FONT ( *struct TextFont, IS )
  52.           Font to be used for rendering.
  53.  
  54.       TLA_DRAWINFO, SYSIA_DRAWINFO ( *struct DrawInfo, IS )
  55.           When not using TLA_FONT, pass here the DrawInfo of
  56.           the screen the gadgets window should/is open. This ensures
  57.           correct calculation of the labels dimensions.
  58.  
  59.       IA_MODE, TLA_MODE ( UBYTE, IS )
  60.           Drawing mode to be used when rendering the text.
  61.  
  62.       IA_FGPEN, TLA_FGPEN ( UBYTE, IS )
  63.       IA_BGPEN, TLA_BGPEN ( UBYTE, IS )
  64.           Pen numbers to be used as foreground and background pens.
  65.           Defaults to BLOCKPEN and BACKGROUNDPEN.
  66.  
  67.       TLA_ADJUSTMENT ( BYTEBITS, IS )
  68.           Defines the adjustment for IM_DRAWFRAME.  See there for
  69.           further information.  This effects only IM_DRAWFRAME.
  70.           Default: center both vertical and horizontal.
  71.  
  72.    BUGS
  73.       textlabel.image may not correctly handle all fonts rendering
  74.       left or above to the starting point.  The image's dimensions
  75.       are not set properly then, too.
  76.  
  77.       Also kerning arround the underscore may not work sufficiently.
  78.  
  79.    NOTE
  80.       Do not set width or hight!  IA_WIDTH and IA_HEIGHT are getable
  81.       only.  Setting these attributes may or may not confuse the
  82.       system.  This may change somewhen, so do not depent on this
  83.       behaviour.
  84.  
  85. textlabel.image/IM_DRAWFRAME                     textlabel.image/IM_DRAWFRAME
  86.  
  87.    NAME
  88.       IM_DRAWFRAME -- Draw text label within a given frame.
  89.  
  90.    FUNCTION
  91.       This method draws the text of the text label object within the
  92.       bounds of a given frame.  The position within the frame
  93.       depents on TLA_ADJUST.  Default is centered both
  94.       horizontal and vertical within the bounds.
  95.  
  96.       TLADJUST_HLEFT
  97.       TLADJUST_HRIGHT
  98.          Adjust the text at the left (right) edge of the frame.
  99.          Default: center text between left and right edge.
  100.  
  101.       TLADJUST_HTOP
  102.       TLADJUST_HBOTTOM
  103.          Adjust the text to the top (bottom) edge of the frame.
  104.          Default: center text between top and bottom of frame.
  105.  
  106.       Out of each group (horizontal and vertical adjustment) you may
  107.       specify not more than one flag.
  108.  
  109.    NOTE
  110.       Specifying more than one flag out of each adjustment group
  111.       may lead to unexcected results.  Never rely on this result
  112.       since this may or may not change in furture.
  113.  
  114.    RESULT
  115.       This method returns 1.
  116.  
  117.